Reorganize contributor docs #7586
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mcmire
force-pushed
the
reorganize-docs
branch
2 times, most recently
from
3b3a74c to
0432905
Compare
mcmire
force-pushed
the
reorganize-docs
branch
3 times, most recently
from
701d482 to
bd00e79
Compare
Most of the contributor docs are kept in one main file, but as time as gone on we have split out specific topics into their own files. Some files are not linked from the main file at all. Finally, one of the files in `docs/` is intended for the `core-backend` repo, not the repo as a whole. Ultimately, this is confusing for contributors. This commit converts the main file to a table of contents, organized by category, and makes sure to link to every file in `docs/`. It also moves the `core-backend`-specific file to that package.
mcmire
force-pushed
the
reorganize-docs
branch
from
bd00e79 to
a1327e2
Compare
Mrtenz
requested changes
Jan 9, 2026
Co-authored-by: Maarten Zuidhoorn <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
Most of the contributor docs are kept in one main file, but as time as gone on we have split out specific topics into their own files. Some files are not linked from the main file at all. Finally, one of the files in
docs/is intended for thecore-backendrepo, not the repo as a whole.Ultimately, this is confusing for contributors.
This commit converts the main file to a table of contents, organized by category, and makes sure to link to every file in
docs/. It also moves thecore-backend-specific file to that package.Note that the exact makeup of the documentation isn't perfect. We might need to rearrange some things a bit so that we have better divisions of content. There is also some duplicated content, particularly around changelogs. I'll work on that in a future PR.
View rendered version
References
Related to https://consensyssoftware.atlassian.net/browse/WPC-199.
Checklist
Note
Revamps contributor documentation into a structured, discoverable layout.
docs/contributing.mdwith a newdocs/README.mdtable-of-contents and adds sectioned guides underdocs/getting-started/,docs/processes/, anddocs/code-guidelines/README.md, PR template,scripts/create-package/README.md, and preview-build message to point to new doc paths.gitignoreto includepackages/core-backend/docsand keeps example/docs ignoresdocs/contributing.mdWritten by Cursor Bugbot for commit 9d711b6. This will update automatically on new commits. Configure here.